<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>octant.io</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="octant-module.html">Package&nbsp;octant</a> ::
        Module&nbsp;io
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module io</h1><p class="nomargin-top"><span class="codelink"><a href="octant.io-pysrc.html">source&nbsp;code</a></span></p>
<p>A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</p>
<p>This module provides two functions, Dataset and MFDataset, that are similar to the
netCDF[3/4] functions of the same name. This package is a thin wrapper around these
functions, and provides two services. First of all, it will use either netCDF3 or
netCDF4 (prefering the later), so that the netCDF package does not need to be changed
on different systems that only have one or the other. Second, it will pass through
netCDF[3/4] objects unchanged, so that netCDF objects, filenames, lists of files, or
strings with wildcards can be passed to the function indescriminately.</p>
<div class="rst-section">
<h1 class="heading"><a id="rst-examples-of-usage" name="rst-examples-of-usage">Examples of usage</a></h1>
<dl class="rst-docutils">
<dt>with an input of a string:</dt>
<dd><p class="rst-first"># returns netCDF4.Dataset object based on file
nc = octant.io.Dataset(file)</p>
<p class="rst-last"># returns MFnetCDF4.Dataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(file)</p>
</dd>
<dt>with an input of a list of files:</dt>
<dd><p class="rst-first"># returns MFDataset object based on list of files
nc = octant.io.Dataset(files)</p>
<p class="rst-last"># returns MFDataset object based on list of files
nc = octant.io.MFDataset(files)</p>
</dd>
<dt>with an input of a netCDF4.Dataset or MFnetCDF4.Dataset object:</dt>
<dd><p class="rst-first"># passes through netCDF4.Dataset or MFnetCDF4.Dataset object
nc = octant.io.Dataset(nc)</p>
<p class="rst-last"># passes through MFDataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(nc)</p>
</dd>
</dl>
</div>

<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.io-module.html#Dataset" class="summary-sig-name">Dataset</a>(<span class="summary-sig-arg">ncfile</span>)</span><br />
      A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.io-pysrc.html#Dataset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.io-module.html#MFDataset" class="summary-sig-name">MFDataset</a>(<span class="summary-sig-arg">ncfile</span>)</span><br />
      A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.io-pysrc.html#MFDataset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="Dataset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Dataset</span>(<span class="sig-arg">ncfile</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.io-pysrc.html#Dataset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</p>
<p>This module provides two functions, Dataset and MFDataset, that are similar to the
netCDF[3/4] functions of the same name. This package is a thin wrapper around these
functions, and provides two services. First of all, it will use either netCDF3 or
netCDF4 (prefering the later), so that the netCDF package does not need to be changed
on different systems that only have one or the other. Second, it will pass through
netCDF[3/4] objects unchanged, so that netCDF objects, filenames, lists of files, or
strings with wildcards can be passed to the function indescriminately.</p>
<div class="rst-section">
<h1 class="heading"><a id="rst-examples-of-usage" name="rst-examples-of-usage">Examples of usage</a></h1>
<dl class="rst-docutils">
<dt>with an input of a string:</dt>
<dd><p class="rst-first"># returns netCDF4.Dataset object based on file
nc = octant.io.Dataset(file)</p>
<p class="rst-last"># returns MFnetCDF4.Dataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(file)</p>
</dd>
<dt>with an input of a list of files:</dt>
<dd><p class="rst-first"># returns MFDataset object based on list of files
nc = octant.io.Dataset(files)</p>
<p class="rst-last"># returns MFDataset object based on list of files
nc = octant.io.MFDataset(files)</p>
</dd>
<dt>with an input of a netCDF4.Dataset or MFnetCDF4.Dataset object:</dt>
<dd><p class="rst-first"># passes through netCDF4.Dataset or MFnetCDF4.Dataset object
nc = octant.io.Dataset(nc)</p>
<p class="rst-last"># passes through MFDataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(nc)</p>
</dd>
</dl>
</div>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="MFDataset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">MFDataset</span>(<span class="sig-arg">ncfile</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.io-pysrc.html#MFDataset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</p>
<p>This module provides two functions, Dataset and MFDataset, that are similar to the
netCDF[3/4] functions of the same name. This package is a thin wrapper around these
functions, and provides two services. First of all, it will use either netCDF3 or
netCDF4 (prefering the later), so that the netCDF package does not need to be changed
on different systems that only have one or the other. Second, it will pass through
netCDF[3/4] objects unchanged, so that netCDF objects, filenames, lists of files, or
strings with wildcards can be passed to the function indescriminately.</p>
<div class="rst-section">
<h1 class="heading"><a id="rst-examples-of-usage" name="rst-examples-of-usage">Examples of usage</a></h1>
<dl class="rst-docutils">
<dt>with an input of a string:</dt>
<dd><p class="rst-first"># returns netCDF4.Dataset object based on file
nc = octant.io.Dataset(file)</p>
<p class="rst-last"># returns MFnetCDF4.Dataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(file)</p>
</dd>
<dt>with an input of a list of files:</dt>
<dd><p class="rst-first"># returns MFDataset object based on list of files
nc = octant.io.Dataset(files)</p>
<p class="rst-last"># returns MFDataset object based on list of files
nc = octant.io.MFDataset(files)</p>
</dd>
<dt>with an input of a netCDF4.Dataset or MFnetCDF4.Dataset object:</dt>
<dd><p class="rst-first"># passes through netCDF4.Dataset or MFnetCDF4.Dataset object
nc = octant.io.Dataset(nc)</p>
<p class="rst-last"># passes through MFDataset object based on file (with wildcard chars)
nc = octant.io.MFDataset(nc)</p>
</dd>
</dl>
</div>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Mon Apr 20 11:56:29 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
